home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #14 / Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO / bbs_door / profil15.zip / PROFILE.DOC < prev    next >
Text File  |  1996-02-15  |  25KB  |  560 lines
  1.  
  2.                              USER PROFILES
  3.  
  4.                                   v1.5
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                   (404) 256-9525 (USR v.everything 33.6)
  12.                   (404) 705-9104 (USR v.everything 33.6)
  13.                   (404) 256-9518 (Voice, 9am-9:30pm EST)
  14.                      (EMAIL) al_lawre@ix.netcom.com
  15.  
  16.  
  17.  
  18.  
  19.                                 OVERVIEW
  20.                                 ________
  21.  
  22.  
  23.    This Door can be used to capture information about a user, for other users 
  24.    to review. The Sysop has complete control over the questions to ask, the 
  25.    way the anwers will be displayed and whether or not to force the user to 
  26.    fill out the questionaire. If your BBS software allows you to execute a 
  27.    Door when a caller logs in, then you can FORCE a user to enter the Door
  28.    and ensure that they answer the questions.
  29.  
  30.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  31.          created in the directory you run the door from.
  32.  
  33.  
  34.  
  35.                 NON-REGISTERED   R E S T R I C T I O N S
  36.                 ----------------------------------------
  37.  
  38.                 ° Limited to 15 callers
  39.                 ° Keyboard timeout value limited to 2 minutes
  40.                 ° Time allowed in door can not be adjusted
  41.                 ° Can not use the command line entry that allows the
  42.                   caller to select a user, display the info and return
  43.                   to the BBS (all from the main menu)
  44.  
  45.  
  46.  
  47.                                 INSTALLATION
  48.                                 ____________
  49.  
  50.  
  51.    Installation is fairly easy and straight-forward. The following steps and
  52.    examples should have you up and running in a very short period of time.
  53.    It is assumed that you are familiar with setting up DOORS on your system.
  54.    To this end, only examples of the configuration file and Door batch file
  55.    are described.
  56.  
  57.       1) Create a directory to hold all PROFILE file
  58.  
  59.       2) Unzip PROFILxx.ZIP into the the above directory
  60.  
  61.       3) Create a configuration file, with a name of your choice, or
  62.          modify the supplied PROFILE.CFG file. A description follows:
  63.  
  64.             **                       Location of system file (See Below)
  65.             SUNRISE-80 BBS           Your BBS Name
  66.             Al                       Sysop's First name
  67.  
  68.             Lawrence                 Sysop's Last Name
  69.  
  70. |-----------------------------------------------------------------------------|
  71. | READ!     1                        CommPort  \ These 2 lines are required   |
  72. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  73. |-----------------------------------------------------------------------------|
  74.  
  75.             00000000                 Registration Number
  76.  
  77.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  78.                                      2 = Display ADOPT-A-DOOR message
  79.     
  80.         #   2                        Keyboard timeout value in Minutes
  81.  
  82.         #   0                        Time  Allowed in Door
  83.                                      (Sysop = Time Remaining - REG. VERSION)
  84.  
  85.             N                       Y = Force a NEW user to answer questions.
  86.                                         This would be used if you were to use 
  87.                                         the Door as part of an AutoLogin 
  88.                                         process. (Will also apply to anyone 
  89.                                         entering the door via your door menu).
  90.                                         Once in the Door the user will HAVE to 
  91.                                         answer the questions with no way out 
  92.                                         until that is done.
  93.                                     N = Participation in the Doors is voluntary 
  94.                                         and the user can exit, without answering 
  95.                                         the questions. If you make this an
  96.                                         Auto-Login Door the caller will be 
  97.                                         presented with the menu. I would NOT 
  98.                                         recommend using the N option if you are 
  99.                                         making this an Auto-Logon door.
  100.  
  101.             0                        0 = Use caller's logon name
  102.                                      1 = Use Alias name (Must use DOOR.SYS)
  103.  
  104.             C:\PROFILE\              Drive:\Path where ALL Picture files
  105.                                      will be kept. You MUST include a trailing
  106.                                      \  or "Bad File Name' type errors will
  107.                                      be encountered.
  108.  
  109.  
  110.           ** = Replace with ONE of the following:
  111.  
  112. C:\bbs\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  113. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  114. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  115. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  116. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  117. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  118. C:\BBS\GTUSER.BBS               <- For GT Power
  119.                                    * if using this option you must put the
  120.                                      ComPort # on line 5 and the Node # on
  121.                                      line 6 of the configuration file
  122.  
  123.  
  124.  
  125.  
  126.            # = Requires registration to change to a different value.
  127.  
  128.                NOTE: There are NO Blank Lines in the Config File!!
  129.  
  130.  
  131.  
  132.  
  133.       4) Create a batch file or modify the PROFILE file supplied. A
  134.          description of this file follows:
  135.  
  136.             ECHO off
  137.             cd\BBS\DOORS\Profile      Location of PROFILE files
  138.             Profile Profile.cfg       EXE filename and CFG filename (Name
  139.                                       used in creating file in #3 above)
  140.             CD\BBS
  141.             BOARD
  142.  
  143.  
  144.        5) When running in more than one node, be sure to supply a
  145.           different configuration name for each node (your choice of name).
  146.  
  147.        6) If running with Fossil-based multi-port boards add
  148.            /FD to the line containing the CFG name as follows:
  149.  
  150.                      PROFILE PROFILE.CFG /FD
  151.  
  152.  
  153.        7) You will be able to supply a user's name on the Command line, and the
  154.           program will search for that user's record, display it and return to
  155.           the BBS. The best way to use this option, which may not be adaptable
  156.           to every BBS software system, is to have a an entry on the main menu
  157.           (call it PROFILE) and using script type languages, ask the caller for
  158.           a name to search for. You would then pass that name to the PROFILE
  159.           command line. After displaying the profile, whether found or not, the
  160.           caller will be taken back to the BBS. An example follows:
  161.  
  162.                        PROFILE PROFILE.CFG \USER:user name here
  163.  
  164.           Please note that the \USER: parameter MUST be the last parameter on
  165.           the command line. There MUST be an exact match for the profile to be
  166.           displayed.
  167.  
  168.  
  169.  
  170.  
  171.  
  172.                                TROUBLESHOOTING
  173.                                ---------------
  174.  
  175. (1) If you are running this Door on a 486 system and encounter errors such as
  176.  
  177.     ERROR 6.... OVERFLOW Error
  178.     ERROR 5.... ILLEGAL Function Call (may be associated with other problems)
  179.     KEYBOARD Timeout after 5 minutes
  180.  
  181.     You may have to put the following line in your AUTOEXEC.BAT file:
  182.  
  183.          SET NO87=ON
  184.  
  185. (2) If you encounter an Error 62 (Input Past End of File), BEFORE you see the
  186.     opening screen of the Door, your problem will more than likely be associated
  187.     with the CFG file. The error 62 means that you do not have enough entries
  188.     in the CFG. Compare your CFG file with the CFG definition in the DOC file.
  189.  
  190.  
  191.  
  192.  
  193. (3) If you encounter an ERROR 70... Permission Denied, this will more than
  194.     likely mean that you DO NOT have SHARE loaded. SHARE is a DOS file that
  195.     comes with your version of DOS. To load it type the word SHARE at the DOS
  196.     prompt. To load it permanently type the word SHARE on a line by itself in
  197.     your AUTOEXEC.BAT file, any place prior to the loading of your BBS
  198.     software. There have been numerous reports that loading SHARE high causes
  199.     some problems, so to be on the safe side, do not load it high.
  200.  
  201.  
  202.    Should you have any questions or problem, please do not hesitate to call
  203.    voice for immediate help... 404-256-9518 (9am-9:30pm EST) any day!
  204.  
  205.  
  206.                           
  207.                        VALID INPUT CHARACTERS (CHAR.OK)
  208.                        --------------------------------
  209.  
  210.    If you wish to restrict the type of characters a caller may enter, in 
  211.    response to any questions, be sure to either create or edit the CHAR.OK 
  212.    file. This file contains all the valid characters you will accept in reponse
  213.    o a Profile question. You can delete CHAR.OK, if you do not wish to 
  214.    validate any input characters or you may edit it to add/change existing 
  215.    entries.
  216.  
  217.    A CHAR.OK file is supplied that contains only the alpha and numeric keys
  218.  
  219.  
  220.  
  221.                          PROFILE MAINTENANCE Program
  222.                          ---------------------------
  223.  
  224.    A maintenance program is supplied that will allow you to View, Delete, 
  225.    Purge Profiles and update the PICTURE field. To execute the  program 
  226.    type the following:
  227.  
  228.                         PROFMANT PROFILE.CFG
  229.  
  230.    Unregisterd version will only allow viewing of the records!
  231.  
  232.  
  233.  
  234.  
  235.                     QUESTIONS/DISPLAY VERBAGE(PROFILE.DAT)
  236.                     ______________________________________
  237.  
  238.       This file contains all the questions you will be asking the callers to 
  239.       complete, whether or not they must answer the question and the 
  240.       corresponding display verbage to be used when displaying the caller's 
  241.       answers to the questions.
  242.  
  243.       PROFILE.DAT an ASCII file created/edited with any ASCII editor. Each 
  244.       line will reference an individual question, with a maximum of 38 
  245.       questions.
  246.  
  247.       The format of each line in the file, is as follows:
  248.  
  249.                      aaaaaaaaaaaa,b,ccccccccccccc
  250.          
  251.           where a = the question to be asked (maximum of 50 characters)
  252.                 b = Y (question MUST be answered)
  253.                     N (question may be bypassed)
  254.                 c = verbage to be used when displaying answer (max of 18 char.)
  255.  
  256.       The program will perform checks on the PROFILE.DAT file and will report 
  257.       any errors it detects. A message will be displayed containing the 
  258.       offending PROFILE.DAT line number and an error number. The error numbers 
  259.       and their meaning follows:
  260.  
  261.           Error 1: Question length greater than 50
  262.           Error 2: 'Must answer' field contains other than Y or N
  263.           Error 3: Display verbage length greater than 18
  264.           Error 4: File contains more than 38 questions
  265.  
  266.       PLEASE NOTE: When designing the questions, bear in mind that answers to 
  267.                    the questions are limited to 18 characters.
  268.  
  269.  
  270.                    
  271.                         FORCE RE-ANSWERING of QUESTIONS
  272.                         -------------------------------
  273.  
  274.       You can use the Profile Maintenance program to clear all answers for 
  275.       every user in the database. By doing this you will force the users to 
  276.       re-answer the questions the next time they enter the Door. If a text file
  277.       named FORCE.TXT is found in the PROFILE directory, it will be displayed 
  278.       just prior to taking the caller to the questions. Thi file could be used
  279.       to explain to the caller why they are being forced to re-answer the 
  280.       questions.
  281.  
  282.  
  283.  
  284.                       PICTURE ATTACH/PICTURE DOWNLOADING
  285.                       __________________________________
  286.  
  287.  
  288.    PROFILE allows the Sysop to ATTACH a picture to a User's profile. 
  289.  
  290.    The format of the picture files are left up to the Sysop (ie: GIF, PCX,
  291.    etc). The caller uploads the picture file to the BBS (hopefully a private
  292.    upload). If the Sysop, after reviewing the file, accepts it he/she uses
  293.    the PROFILE Maintenance program (PROFMANT View Option) to view the
  294.    caller's profile and add the FILENAME of the picture to the appropriate
  295.    field in the caller's record. The Drive:\Path\ to the Picture Filename
  296.    must be defined in the PROFILE.CFG file.
  297.  
  298.    Callers that choose to view another callers profile, will be informed that
  299.    there is a picture available for Downloading/Viewing. The caller is given
  300.    the option of downloading it and viewing it offline OR if they are using a
  301.    terminal program with a GIF viewer TSR, viewing it as they download it.
  302.  
  303.  
  304.  
  305.                    UPLOAD/DOWNLOAD FILE TRANSFER PROTOCOLS
  306.                    ---------------------------------------
  307.  
  308.       PROFILE externalizes all file transfer protocols used for Downloading 
  309.       of the PROFILE user pictures. This allows the Sysop to define the file 
  310.       transfer protocols they wish to support.
  311.  
  312.       A file called PROTOCOL.DAT is supplied with protocols already defined,
  313.       which you may alter at any time. Each entry in the PROTOCOL.DAT file
  314.       consists of the description that will be displayed to the caller on the
  315.       Protocol Menu and the 'high level' name of the protocol's batch files.
  316.  
  317.                Example:  ZModem   Upload or Download, ZPROT
  318.  
  319.       The information to the left of the comma is the description (NOTE: Only
  320.       ONE comma permitted per line and it can NOT be part of the description).
  321.       PROFILE requires that you have 1 batch file in the PROFILE directory to 
  322.       handle the downloading. In the above example ZPROT is the 'high level' 
  323.       portion of the batch file name required for ZMODEM. Your PROFILE 
  324.       directory should contain ZPROTS.BAT. 
  325.  
  326.       Each protocol batch file MUST contain 2 batch file variables as follows:
  327.  
  328.       %1 = PROFILE will use this variable to substitute the current ComPort
  329.       %2 = PROFILE will use this variable to substitute the file name
  330.  
  331.       IMPORTANT! Place the variable (%1 and %2) ONLY in the EXACT location that
  332.                  your protocol requires them, in the protocol command line. Do
  333.                  NOT supply the ComPort or FileName, JUST the %1 and %2
  334.                  variables themselves (%1 and %2)!
  335.  
  336.       See example batch files supplied with the PROFILE. They are the ones
  337.       being used on the Sunrise-80 BBS.
  338.  
  339.  
  340.                              *** PLEASE NOTE ***
  341.  
  342.       There may come a time when you will need to supply information to the
  343.       protocol you are using, based on the node it will be used on. You can
  344.       accomplish this by supplying a node-specific PROTOCOL file. Everything
  345.       described above stays the same except that you will name the file
  346.       PROTOCOL.x (where x is the node number). For example, to use a special
  347.       set of protocols (or batch files) on node number 5, modify a copy of
  348.       PROTOCOL.DAT and name it PROTOCOL.5. PROFILE will use PROTOCOL.5 when
  349.       someone logs on node 5 and will use PROTOCOL.DAT for ALL OTHERS. You do
  350.       not have to create node-specific PROTOCOL files for all nodes.. just the
  351.       node(s) that are different.
  352.  
  353.  
  354.  
  355.  
  356.                                 TRASHCAN FILE
  357.                                 _____________
  358.  
  359.       This is a text file you must create (if you wish to use one), with
  360.       a file name of PROFTCAN.DAT and it must reside in the Door directory.
  361.  
  362.       This file is used if you want to block the use of "offensive" words
  363.       callers may choose to use. Each word must appear on a separate line
  364.       within the text file with a maximum of 100 words.
  365.  
  366.       NOTE: The word must match EXACTLY !!!
  367.  
  368.  
  369.  
  370.                           NON-STANDARD COM SUPPORT
  371.                           ________________________
  372.  
  373.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  374.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  375.       number after the configuration filename. Let's assume your Door is
  376.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  377.       passed to your Door would be:
  378.  
  379.                             FOOBAR FOOBAR.CFG /5
  380.  
  381.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  382.       normally used with COM1. No /x parameter is needed for the standard
  383.       IRQ's.
  384.  
  385.       As an alternative, you may use an environmental variable on the command
  386.       line. To use the variable (following the example above), place a
  387.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  388.       different IRQ number for each node). The command line would now look
  389.       like this:
  390.  
  391.                           FOOBAR FOOBAR.CFG /%IRQ%
  392.  
  393.       This, in combination with the use of the environmental variables
  394.       described in the MULTI-NODE SETUP section will allow you to use one
  395.       batch file and one config file to run this door on all nodes.
  396.  
  397.  
  398.  
  399.  
  400.                               MULTI-NODE SETUP
  401.                               ________________
  402.  
  403.       All Sunrise Doors are Multi-Node capable. Each node must have the
  404.       ability to access a configuration file which will have its own system
  405.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  406.       line. There are 2 ways to accomplish this:
  407.  
  408.       (1) Create a separate configuration file for each node. The only
  409.           difference between each file would be the location of the system
  410.           file for that particular node. For example, on my system there are 2
  411.           nodes and the first line of the config files would look like this:
  412.  
  413.                         NODE1:  H:\PCB1\DOOR.SYS
  414.                         NODE2:  H:\PCB2\DOOR.SYS
  415.  
  416.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  417.  
  418.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  419.           the following PCBoard/Wildcat environmental variables:
  420.  
  421.                  PCBDIR    (Directory containing the System file)
  422.                  PCBDRIVE  (Drive containing the System file)
  423.                  WCNODEID  (Active Node Number)
  424.  
  425.           Thus, the first line of the SINGLE configuration file, for this Door
  426.           would look like this:
  427.  
  428.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  429.                         c:\wc30\wcwork\node%wcnodeid%\door.sys
  430.  
  431.       NOTE: This option, as described, assumes that you are running PCB or
  432.             Wildcat software. The environmental variables are automatically
  433.             created by the software for each node.
  434.  
  435.             HOWEVER, if you are running other BBS software you should be able
  436.             to set the variables EXACTLY as described below, for EACH node
  437.             (more than likely in each batch file you use to bring up EACH node):
  438.  
  439.                             PCBDRIVE=C:
  440.                             ^^^^^^^^^
  441.                             PCBDIR=\NODE2
  442.                             ^^^^^^^^
  443.  
  444.             Info with a carat (^) under it, MUST be typed as is. The rest
  445.             depends on your naming conventions.
  446.  
  447.             This, in combination with the use of the optional environmental
  448.             variable described in the NON-STANDARD COM SUPPORT section, will
  449.             allow you to use one batch file and one config file to run this
  450.             door on all nodes.
  451.  
  452.  
  453.  
  454.  
  455.                                 ADOPT-A-DOOR
  456.                                 ____________
  457.  
  458.     Having been a Sysop for a number of years, I have had my share of problems
  459.     and frustrations getting financial support for my board's upkeep. A fellow
  460.     Sysop left a message on my board, not long ago, about a concept that was
  461.     being used by several boards around the country.
  462.  
  463.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  464.     would be the same as sending in a donation, only this way it is earmarked
  465.     for registering a particular door. In a way, the user feels he/she is
  466.     "getting something in return". As a Door author I have decided to build
  467.     this concept into each of my Door programs. The concept replaces the
  468.     usual message "tell the Sysop to register this Door" we find in most
  469.     doors.
  470.  
  471.     If the Door is unregisterd then a message appears on the opening screen
  472.     to that effect. After finishing or suspending a game, a message screen
  473.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  474.     caller to contact the Sysop to find out if there is any further details
  475.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  476.     time, etc to callers that ADOPT-A-DOOR.
  477.  
  478.     If the Door has been registered, either by the Sysop or other callers,
  479.     the names of those contributors will be displayed in the closing screen.
  480.  
  481.     NOTE: If you want to display the names of the callers that contributed
  482.           to registering the Door, you must create an ASCII file called
  483.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  484.           the name(s) of the contributors (one on each line, maximum of 5
  485.           entries, each a maximum of 30 characters long). This file must be
  486.           saved, in ASCII format, and placed in the Door directory.
  487.  
  488.  
  489.  
  490.                                   LEGALITIES
  491.                                   __________
  492.  
  493.  
  494.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  495.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  496.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  497.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  498.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  499.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  500.       OR BREACH OF ANY WARRANTY.
  501.  
  502.  
  503.  
  504.  
  505.  
  506.                                 DISTRIBUTION
  507.                                 ____________
  508.  
  509.    You may make this file available for downloading from your BBS or you may
  510.    upload it to any BBS of your choice, provided that you do not make any
  511.    changes to the contents of the archive (ZIP file). The archive and its
  512.    individual contents may not be used by any service that charges any money
  513.    whatsoever, without the written permission of the author.
  514.  
  515.  
  516.  
  517.  
  518.  
  519.                                 REGISTRATION
  520.                                 ____________
  521.  
  522.    Registration and the subsequent insertion of the registration number into
  523.    your configuation file, allows for the display of your BBS name on the
  524.    opening and closing screen as well as the reduction of a delay built into
  525.    the opening screen display along with the ability to change certain
  526.    values in the configuration file.
  527.  
  528.    To register your copy of PROFILE, please fill out the registration form
  529.    (REGISTER.FRM) and mail it along with the registration fee to
  530.    the name and address on the form.
  531.  
  532.    Once a door is registered, any changes to registration information (Sysop
  533.    name or BBS Name) will require the doors to be re-registered. Download or
  534.    File Request a file named CHANGE.FRM from our BBS, complete the form and
  535.    follow ALL instructions in the document!
  536.  
  537.    Registration fees are subject to change at any time. The most current
  538.    registration form is always available on our BBS. You may download or
  539.    File Request REGISTER.FRM at any time.
  540.  
  541.    Be sure to use the proper upper/lower case when filling in your name and
  542.    BBS name, as they MUST match the way you entered them in the configuration
  543.    file.             ^^^^
  544.  
  545.    Based upon information supplied on the registration form, I will pre-
  546.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  547.    up your registration number.
  548.  
  549.  
  550.  
  551.                                     MISC
  552.                                     ____
  553.  
  554.    The latest version of PROFILE and other fine SUNRISE DOOR programs are
  555.    always available for download from SUNRISE-80 BBS.
  556.  
  557.    Remember, should you have any problems, questions or suggestions, be sure
  558.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  559.    PCBHints, SYSops), SMARTNET (SN_Sysops), FIDOnet 1:133/410
  560.